Add Subscriber Email
The Add Subscriber Email request lets you add a subscriber email address.
URI
{{baseUrl}}/api/v2/customer/{customerGuid}/user/{subscriberEmail}/script
HTTP Method
POST
Request Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
customerGuid * string($uuid) |
path |
Customer subscriber Azure Tenant Guid. |
|
subscriberEmail * string |
path |
Customer subscriber Email address. |
Request Body
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Ovoc-Channel-Id |
integer channel identifier |
Filter access to customers belonging to the specified channel. See Get List of Channels to retrieve channel Ids. |
Response
| ■ | 200 Success |
| ■ | 400 Bad Request |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
string |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
|
Error trace Id. |
|
instance |
string |
Error instance. |
|
Cac Profile |
string |
Information related to configured CAC sessions. |
|
ProxySet |
string |
Information related to SBC Proxy Sets. |
|
OnlinePstnGateway |
string |
Information related to OnlinePSTN Gateway of the SBC device attached to Calling Profiles (see Get Online PSTN Gateway). |
| ■ | 409 Conflict |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
string |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
|
Error trace Id. |
|
instance |
string |
Error instance. |
|
Cac Profile |
string |
Information related to configured CAC sessions. |
|
ProxySet |
string |
Information related to SBC Proxy Sets. |
|
OnlinePstnGateway |
string |
Information related to OnlinePSTN Gateway of the SBC device attached to Calling Profiles (see Get Online PSTN Gateway). |
| ■ | 500 Server Error |